<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>XenC: Eval Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">XenC
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Open-source tool for data selection in NLP</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_eval-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Eval Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Evaluation system.  
 <a href="class_eval.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="eval_8h_source.html">eval.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa435bcc0f16c106c11f194ade790409c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_eval.html#aa435bcc0f16c106c11f194ade790409c">Eval</a> ()</td></tr>
<tr class="memdesc:aa435bcc0f16c106c11f194ade790409c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#aa435bcc0f16c106c11f194ade790409c">More...</a><br /></td></tr>
<tr class="separator:aa435bcc0f16c106c11f194ade790409c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae880ef126254582bacc64f2902789d7b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_eval.html#ae880ef126254582bacc64f2902789d7b">Eval</a> (std::string distFile)</td></tr>
<tr class="memdesc:ae880ef126254582bacc64f2902789d7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor from a string.  <a href="#ae880ef126254582bacc64f2902789d7b">More...</a><br /></td></tr>
<tr class="separator:ae880ef126254582bacc64f2902789d7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40dcca6dc5c42076626a4c6690a9b0c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_eval.html#a40dcca6dc5c42076626a4c6690a9b0c3">~Eval</a> ()</td></tr>
<tr class="memdesc:a40dcca6dc5c42076626a4c6690a9b0c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a40dcca6dc5c42076626a4c6690a9b0c3">More...</a><br /></td></tr>
<tr class="separator:a40dcca6dc5c42076626a4c6690a9b0c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c3f6f4605b2763e8e18a12b54779baf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_eval.html#a0c3f6f4605b2763e8e18a12b54779baf">doEval</a> (int high, int low)</td></tr>
<tr class="memdesc:a0c3f6f4605b2763e8e18a12b54779baf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes an evaluation bount by the high and low integers (in percentage)  <a href="#a0c3f6f4605b2763e8e18a12b54779baf">More...</a><br /></td></tr>
<tr class="separator:a0c3f6f4605b2763e8e18a12b54779baf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f7cf5cbc48c414a0cef2a8ccb27ad56"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_eval.html#a9f7cf5cbc48c414a0cef2a8ccb27ad56">doBP</a> ()</td></tr>
<tr class="memdesc:a9f7cf5cbc48c414a0cef2a8ccb27ad56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the best theoretical point based on current evaluation.  <a href="#a9f7cf5cbc48c414a0cef2a8ccb27ad56">More...</a><br /></td></tr>
<tr class="separator:a9f7cf5cbc48c414a0cef2a8ccb27ad56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac58c34b59f9e536e78bf36f915f9b9c3"><td class="memItemLeft" align="right" valign="top">boost::shared_ptr&lt; <a class="el" href="eval_8h.html#a2c850c27efca97b26b551ccdc42fd7b2">EvalMap</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_eval.html#ac58c34b59f9e536e78bf36f915f9b9c3">getDist</a> () const </td></tr>
<tr class="memdesc:ac58c34b59f9e536e78bf36f915f9b9c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the evaluation distribution map.  <a href="#ac58c34b59f9e536e78bf36f915f9b9c3">More...</a><br /></td></tr>
<tr class="separator:ac58c34b59f9e536e78bf36f915f9b9c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2582acb2adec4a535072e06fecb20c60"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_eval.html#a2582acb2adec4a535072e06fecb20c60">getBP</a> ()</td></tr>
<tr class="memdesc:a2582acb2adec4a535072e06fecb20c60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accessor to the determined best point.  <a href="#a2582acb2adec4a535072e06fecb20c60">More...</a><br /></td></tr>
<tr class="separator:a2582acb2adec4a535072e06fecb20c60"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Evaluation system. </p>
<p>This class handles the evaluation procedure in XenC, providing mean to perform eval, best point, and getting the results. It uses threads extensively, so please watch your memory usage since there is some memory leaks in SRILM. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa435bcc0f16c106c11f194ade790409c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Eval::Eval </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default constructor. </p>

</div>
</div>
<a class="anchor" id="ae880ef126254582bacc64f2902789d7b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Eval::Eval </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>distFile</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor from a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">distFile</td><td>: string containing a valid path to the evaluation (*.dist) file, usually used when doing BP </td></tr>
  </table>
  </dd>
</dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_eval_ae880ef126254582bacc64f2902789d7b_cgraph.png" border="0" usemap="#class_eval_ae880ef126254582bacc64f2902789d7b_cgraph" alt=""/></div>
<map name="class_eval_ae880ef126254582bacc64f2902789d7b_cgraph" id="class_eval_ae880ef126254582bacc64f2902789d7b_cgraph">
<area shape="rect" id="node2" href="class_xen_i_o.html#af153c980efc7a1bf6994300ca2a5edc7" title="Reads a evaluation/best point distribution file. " alt="" coords="134,31,250,56"/>
<area shape="rect" id="node3" href="namespace_xen_common.html#a3fd9978be1bd41808ac4605c2e89d816" title="Template converting a value (generally a string) into an integer. " alt="" coords="312,5,444,31"/>
<area shape="rect" id="node4" href="namespace_xen_common.html#aadf35ed2e4ebb9b556cda62563888113" title="Template converting a value (generally a string) into an double. " alt="" coords="298,55,458,80"/>
</map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a40dcca6dc5c42076626a4c6690a9b0c3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Eval::~Eval </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9f7cf5cbc48c414a0cef2a8ccb27ad56"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Eval::doBP </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Computes the best theoretical point based on current evaluation. </p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_eval_a9f7cf5cbc48c414a0cef2a8ccb27ad56_cgraph.png" border="0" usemap="#class_eval_a9f7cf5cbc48c414a0cef2a8ccb27ad56_cgraph" alt=""/></div>
<map name="class_eval_a9f7cf5cbc48c414a0cef2a8ccb27ad56_cgraph" id="class_eval_a9f7cf5cbc48c414a0cef2a8ccb27ad56_cgraph">
<area shape="rect" id="node2" href="class_xen_option.html#a97ad096aee729b4d8ae993b1381d4eec" title="Accessor to the instance of the singleton XenOption object. " alt="" coords="382,5,542,31"/>
<area shape="rect" id="node3" href="class_xen_option.html#a119290088f94fed09b70076920e7bce0" title="XenOption::getMaxEvalPC" alt="" coords="141,704,321,729"/>
<area shape="rect" id="node4" href="class_xen_option.html#a8b583f9e5188f8e97d204d2ddf860d51" title="Mutator to the evaluation/best point step size. " alt="" coords="162,753,299,779"/>
<area shape="rect" id="node5" href="class_xen_option.html#a78676f439ad9c8d20268ec8bb3752391" title="Accessor to the step size for evaluation/best point. " alt="" coords="393,55,531,80"/>
<area shape="rect" id="node6" href="namespace_xen_common.html#ad4f4868634e46d6ee82e57d343a77abe" title="Template converting a value into a string with a precision of 20. " alt="" coords="603,453,756,479"/>
<area shape="rect" id="node7" href="class_eval.html#a0c3f6f4605b2763e8e18a12b54779baf" title="Computes an evaluation bount by the high and low integers (in percentage) " alt="" coords="183,328,278,353"/>
<area shape="rect" id="node8" href="class_static_data.html#a3cc0816b2220ee3f827cdd00971e010d" title="Accessor to the instance of the singleton StaticData object. " alt="" coords="382,255,541,280"/>
<area shape="rect" id="node9" href="class_xen_option.html#a74178ef5302c1bf213822ae474c58806" title="Accessor to the source language vocabulary file. " alt="" coords="384,403,540,428"/>
<area shape="rect" id="node10" href="class_static_data.html#a0a84fa1648aed88951cf2870a9f39b4d" title="Accessor to the vocabularies. " alt="" coords="386,452,538,477"/>
<area shape="rect" id="node11" href="class_static_data.html#a60a4636843c37cbb31780ec4d185a06d" title="Accessor to the source language Corpus Pair. " alt="" coords="369,501,555,527"/>
<area shape="rect" id="node12" href="class_xen_option.html#a1e63941bf583b329394def43e580bbd6" title="Accessor to the requested number of threads. " alt="" coords="382,603,541,628"/>
<area shape="rect" id="node13" href="class_static_data.html#a432dc2b3876cffc6eae2765f11454415" title="Accessor to the filtering result file. " alt="" coords="377,104,547,129"/>
<area shape="rect" id="node14" href="class_xen_i_o.html#aeb32c268deb43ffb242f30726ff4105b" title="Writes a part of the text of a XenResult given a percentage. " alt="" coords="394,353,530,379"/>
<area shape="rect" id="node15" href="eval_8cpp.html#a08bdd00a4373b59f0e8040c9b62e66ec" title="Thread&#45;safe evaluation function. " alt="" coords="426,304,498,329"/>
<area shape="rect" id="node16" href="class_xen_i_o.html#a61aa80bb58f6a42aa52b7360758ba431" title="Deletes a file from the filesystem. " alt="" coords="627,255,732,280"/>
<area shape="rect" id="node17" href="class_static_data.html#a82a7803b30ab037009d312d7ac40822b" title="Accessor to the development Corpus. " alt="" coords="381,153,543,179"/>
</map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a0c3f6f4605b2763e8e18a12b54779baf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Eval::doEval </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>high</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>low</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Computes an evaluation bount by the high and low integers (in percentage) </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">high</td><td>: integer representing the upper bound for evaluation </td></tr>
    <tr><td class="paramname">low</td><td>: integer representing the lower bound for evaluation </td></tr>
  </table>
  </dd>
</dl>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_eval_a0c3f6f4605b2763e8e18a12b54779baf_cgraph.png" border="0" usemap="#class_eval_a0c3f6f4605b2763e8e18a12b54779baf_cgraph" alt=""/></div>
<map name="class_eval_a0c3f6f4605b2763e8e18a12b54779baf_cgraph" id="class_eval_a0c3f6f4605b2763e8e18a12b54779baf_cgraph">
<area shape="rect" id="node2" href="class_xen_option.html#a97ad096aee729b4d8ae993b1381d4eec" title="Accessor to the instance of the singleton XenOption object. " alt="" coords="162,5,322,31"/>
<area shape="rect" id="node3" href="class_static_data.html#a3cc0816b2220ee3f827cdd00971e010d" title="Accessor to the instance of the singleton StaticData object. " alt="" coords="162,55,322,80"/>
<area shape="rect" id="node4" href="class_xen_option.html#a74178ef5302c1bf213822ae474c58806" title="Accessor to the source language vocabulary file. " alt="" coords="164,104,320,129"/>
<area shape="rect" id="node5" href="class_static_data.html#a0a84fa1648aed88951cf2870a9f39b4d" title="Accessor to the vocabularies. " alt="" coords="166,153,318,179"/>
<area shape="rect" id="node6" href="class_static_data.html#a60a4636843c37cbb31780ec4d185a06d" title="Accessor to the source language Corpus Pair. " alt="" coords="149,203,335,228"/>
<area shape="rect" id="node7" href="class_xen_option.html#a1e63941bf583b329394def43e580bbd6" title="Accessor to the requested number of threads. " alt="" coords="162,252,322,277"/>
<area shape="rect" id="node8" href="class_xen_option.html#a78676f439ad9c8d20268ec8bb3752391" title="Accessor to the step size for evaluation/best point. " alt="" coords="173,301,311,327"/>
<area shape="rect" id="node9" href="class_static_data.html#a432dc2b3876cffc6eae2765f11454415" title="Accessor to the filtering result file. " alt="" coords="157,351,327,376"/>
<area shape="rect" id="node10" href="namespace_xen_common.html#ad4f4868634e46d6ee82e57d343a77abe" title="Template converting a value into a string with a precision of 20. " alt="" coords="383,452,536,477"/>
<area shape="rect" id="node11" href="class_xen_i_o.html#aeb32c268deb43ffb242f30726ff4105b" title="Writes a part of the text of a XenResult given a percentage. " alt="" coords="174,452,310,477"/>
<area shape="rect" id="node12" href="eval_8cpp.html#a08bdd00a4373b59f0e8040c9b62e66ec" title="Thread&#45;safe evaluation function. " alt="" coords="206,501,278,527"/>
<area shape="rect" id="node13" href="class_xen_i_o.html#a61aa80bb58f6a42aa52b7360758ba431" title="Deletes a file from the filesystem. " alt="" coords="407,527,513,552"/>
<area shape="rect" id="node14" href="class_static_data.html#a82a7803b30ab037009d312d7ac40822b" title="Accessor to the development Corpus. " alt="" coords="161,603,323,628"/>
</map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_eval_a0c3f6f4605b2763e8e18a12b54779baf_icgraph.png" border="0" usemap="#class_eval_a0c3f6f4605b2763e8e18a12b54779baf_icgraph" alt=""/></div>
<map name="class_eval_a0c3f6f4605b2763e8e18a12b54779baf_icgraph" id="class_eval_a0c3f6f4605b2763e8e18a12b54779baf_icgraph">
<area shape="rect" id="node2" href="class_eval.html#a9f7cf5cbc48c414a0cef2a8ccb27ad56" title="Computes the best theoretical point based on current evaluation. " alt="" coords="149,5,236,31"/>
</map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a2582acb2adec4a535072e06fecb20c60"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Eval::getBP </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the determined best point. </p>
<dl class="section return"><dt>Returns</dt><dd>integer representing the percentage for the best point </dd></dl>

</div>
</div>
<a class="anchor" id="ac58c34b59f9e536e78bf36f915f9b9c3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boost::shared_ptr&lt; <a class="el" href="eval_8h.html#a2c850c27efca97b26b551ccdc42fd7b2">EvalMap</a> &gt; Eval::getDist </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Accessor to the evaluation distribution map. </p>
<dl class="section return"><dt>Returns</dt><dd>shared pointer on EvalMap containing all the evaluation results </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="eval_8h_source.html">eval.h</a></li>
<li>src/<a class="el" href="eval_8cpp.html">eval.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 18 2016 17:22:37 for XenC by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
